-
-
Notifications
You must be signed in to change notification settings - Fork 7.5k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Ads #4115
Ads #4115
Conversation
@MrLeeH Please specify the related parent PR in the start post. |
source/_components/ads.markdown
Outdated
|
||
{% configuration %} | ||
|
||
- **device** (*Required*): The AMS NetId that identifies the device. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This should be written using a kind of yaml syntax. See:
https://raw.githubusercontent.com/home-assistant/home-assistant.github.io/next/source/_components/dominos.markdown
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Done.
|
||
{% configuration %} | ||
|
||
- **adsvar** (*Required*): The name of the variable which you want to access on |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Syntax.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Done.
|
||
{% configuration %} | ||
|
||
- **adsvar** (*Required*): The name of the boolean variable that switches the |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Syntax.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Done.
|
||
{% configuration %} | ||
|
||
- **adsvar** (*Required*): The name of the variable which you want to access on |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Syntax.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
is there a default keyword for default values or should I just add the default value to the description?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
There is a default
key, so use that, 👍.
Configuration variables: | ||
|
||
{% configuration %} | ||
- **adsvar** (*Required*): The name of the variable which you want to access on |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Syntax.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Done.
source/_components/ads.markdown
Outdated
footer: true | ||
logo: home-assistant.png | ||
ha_category: Hub | ||
ha_release: 0.59 |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
"0.60"
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Done.
footer: true | ||
logo: home-assistant.png | ||
ha_category: Binary Sensor | ||
ha_release: 0.59 |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
"0.60"
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Done.
footer: true | ||
logo: home-assistant.png | ||
ha_category: Light | ||
ha_release: 0.59 |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
"0.60"
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Done.
footer: true | ||
logo: home-assistant.png | ||
ha_category: Sensor | ||
ha_release: 0.59 |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
"0.60"
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Done.
footer: true | ||
logo: home-assistant.png | ||
ha_category: Switch | ||
ha_release: 0.59 |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
"0.60"
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Done.
name: | ||
required: false | ||
description: An identifier for the sensor | ||
factor: |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
name
(the key above factor
) is missing the type
key-value pair.
factor: | ||
required: false | ||
description: A factor that divides the stored value before displaying in Home Assistant | ||
default: 1 | ||
{% endconfiguration %} |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
No type
here for factor
either.
adsvar: | ||
required: true | ||
description: The name of the variable which you want to access on the ADS device | ||
name: |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Missing type
for adsvar
.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks!
* add ads hub and switch * add ads binary sensor * add ADS sensor * fix version numbers * separate configuration tag * remove device notification config * fix configuration schema. * replace tabs with spaces * add type key-value-pairs
* add ads hub and switch * add ads binary sensor * add ADS sensor * fix version numbers * separate configuration tag * remove device notification config * fix configuration schema. * replace tabs with spaces * add type key-value-pairs
Description:
Refers to closed PR #3777.
Add documentation for new ADS component.
Pull request in home-assistant (if applicable):
home-assistant/core#10142
Checklist:
current
. New documentation for platforms/components and features should go tonext
.